Skip to content

docs: overhaul main README and update site title to OpenUI5 Tutorials - #328

Merged
petermuessig merged 1 commit into
mainfrom
docs/readme-overhaul
Aug 13, 2026
Merged

docs: overhaul main README and update site title to OpenUI5 Tutorials#328
petermuessig merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@margopolo

Copy link
Copy Markdown
Contributor

This PR updates the repository-level documentation and site title across ~6 files.

1. Main README overhaul

Replaces the flat description with a structured Learning path table
(Foundation vs. Deep dive), a Repository structure section, and
updated prerequisites. Also fixes multiple typos and a non-breaking space
in the Data Binding row.

2. Quickstart README update

Rewrites the description to reflect the actual scope of the tutorial
(MVC basics, data binding showcase, navigation in action).

3. Site title rename

Updates "UI5 Tutorials" → "OpenUI5 Tutorials" in the GH Pages builder
(prepare-gh-pages.js) and the dev-server template (ghpage-template.hbs).

4. Minor text fixes

  • packages/quickstart/steps/01/README.md: "UI5 libraries" → "OpenUI5 libraries"; removes extra whitespace
  • packages/walkthrough/README.md: minor wording adjustment

@petermuessig
petermuessig merged commit 6ee9134 into main Aug 13, 2026
3 checks passed
@petermuessig
petermuessig deleted the docs/readme-overhaul branch August 13, 2026 04:57

@KlattG KlattG left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LATE] I found some grammar issues - please correct!

```

To use install the required UI5 libraries, execute the following command:
To use install the required OpenUI5 libraries, execute the following command:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use install the required OpenUI5 libraries, execute the following command:
To install the required OpenUI5 libraries, execute the following command:

#### ui5.yaml

Next, we have to configure the tooling extension we installed from npm to our UI5 CLI setup, so we can use them in our project. To hook a custom task into a certain build phase of a project, it needs to reference another task that will get executed before or after it. The same applies for a custom middleware:
Next, we have to configure the tooling extension we installed from npm to our UI5 CLI setup, so we can use them in our project. To hook a custom task into a certain build phase of a project, it needs to reference another task that will get executed before or after it. The same applies for a custom middleware:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Next, we have to configure the tooling extension we installed from npm to our UI5 CLI setup, so we can use them in our project. To hook a custom task into a certain build phase of a project, it needs to reference another task that will get executed before or after it. The same applies for a custom middleware:
Next, we have to configure the tooling extension we installed from npm to our UI5 CLI setup, so we can use it in our project. To hook a custom task into a certain build phase of a project, it needs to reference another task that will get executed before or after it. The same applies for a custom middleware:

petermuessig added a commit that referenced this pull request Aug 13, 2026
Address KlattG's review comments on #328:
- "To use install the required OpenUI5 libraries" -> "To install the
  required OpenUI5 libraries" (stray "use").
- "so we can use them in our project" -> "so we can use it in our
  project" (singular: the tooling extension).
petermuessig added a commit that referenced this pull request Aug 13, 2026
Address KlattG's review comments on #328:
- "To use install the required OpenUI5 libraries" -> "To install the
  required OpenUI5 libraries" (stray "use").
- "so we can use them in our project" -> "so we can use it in our
  project" (singular: the tooling extension).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants